Call-Home Configuration Mode

Call-Home Configuration Mode
 
 
The Call-Home Configuration Mode is used to manage configuration parameters for the Smart Call Home feature. Smart Call Home is a service that sends real-time alerts, remediation, and personalized web-based reports to the Technical Assistance Center (TAC) and other configured profiles.
 
 
activate
Use this command to activate the call-home service.
Product
All
Privilege
Security Administrator, Administrator
Syntax
activate
default activate
no activate
default
Configures the call-home service back to default settings.
no
Disables the call-home services.
Usage
Use this command to enable the call-home services.
Example
The following command disables the call-home service :
no activate
 
alert-group
This command enables or disables the alert-group.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] alert-group { all | configuration | crashinfo | diagnostic | environment | inventory | syslog }
all
Enables an alert group for all categories.
configuration
Enables an alert group related to configuration.
crashinfo
Enables an alert group related to crashes.
default
Configures the alert-group back to default settings. The default is enabled.
diagnostics
Enables an alert group related to diagnostics.
environment
Enables an alert group related to environment. These typically include events related to power, fan, and temperature alarms.
inventory
Enables an alert group related to inventory. This is a non-critical event that could include notifications when cards are inserted or removed or when the system is cold-booted.
no
Disables the alert-groups.
syslog
Enables an alert group related to syslog. This includes events generated by the syslog PORT facility.
Usage
An alert group is a predefined subset of Smart Call Home alerts that are supported on this device. Alert groups allow you to select the set of Smart Call Home alerts that you want to send to a predefined or custom destination profile.
Example
The following command enables alerts for all of the preconfigured Smart Call Home alerts:
alert-group all
 
chassis-serial-number
This command sets the serial number for the chassis.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[no] chassis-serial-number
no
Removes the chassis-serial-number.
Usage
Use this command to set the chassis serial number. The maximum number of characters to use is 11. If you include spaces, then you must enclose your entry in quotes.
Example
The following command sets the chassis serial number to chassis 1:
chassis-serial-number “chassis 1”
The following command sets the chassis serial number to chassis12:
chassis-serial-number chassis12
 
contact-email-addr
This command sets the e-mail address of person identified as the contact for this unit.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no ] contact-email-addr
no
Removes the contact email address.
Usage
Use this command to set up the email address for the person identified as the contact person for this device.
The e-mail address is of the form local-part@domain where domain can be made up of a number of labels, each separated by a period and between 1 and 63 characters in length. The local-part can be 1-64 characters. The domain-label can be 1-63 characters. The domain can be 1-135 characters. The entire string can be a no larger than 200 characters.
note_smallImportant: You can use any valid e-mail address. You cannot use spaces.
Example
The following command specifies the contact person’s email address:
contact-email-addr contact.name@domain.com
 
contract-id
This command configures the system’s contract-identifier for Cisco’s AutoNotify.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] contract-id
default
Configures the call-home contract-id back to default settings.
no
Removes the call-home contract-id.
Usage
Use this command to set up the system’s contract ID for Cisco’s AutoNotify.
The contract-id can be between 1 and 64 alpha and/or numeric characters and is case sensitive. If you include spaces in the contract-id, you must enclose it in quotes.
Example
The following command specifies the contract-id as Contract1234_ID:
contract-id Contract1234_ID
 
customer-id
This command configures the system’s customer-identifier for Cisco’s AutoNotify.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] customer-id
default
Configures the call-home customer-id back to default settings.
no
Removes the call-home customer-id.
Usage
Use this command to set up the system’s customer ID for Cisco’s AutoNotify.
The customer-id can be between 1 and 64 alpha and/or numeric characters and is case sensitive. If you include spaces in the contract-id, you must enclose it in quotes.
Example
The following command specifies the customer-id as CustID_1234:
customer-id CustID_1234
 
end
Exits the current configuration mode and returns to the Exec mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
end
Usage
Use this command to return to the Exec mode.
 
exit
Exits the current mode and returns to the parent configuration mode.
Product
All
Privilege
Security Administrator, Administrator
Syntax
exit
Usage
Use this command to return to the parent configuration mode.
 
mail-server
This command configures the call-home mail-server.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no ] mail-server server_name priority priority_num
no
Removes the call-home mail-server.
priority
Sets the mail server priority order. The priority can be set from 1- 100.
Usage
Use this command to set up the mail server for Smart Call Home.
Specifies and configure the various mail servers using an IPv4 address. This configuration is mandatory when the user profile is configured to only send out email messages.
Example
The following command specifies the mail-server as 1.2.3.4 with a priority of 1:
mail-server 1.2.3.4 priority 1
 
phone-number
This command enables or disables the phone-number for the call-home contact person.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no | default ] phone-number phone-number-string
default
Configures the phone number back to default settings. The default is enabled.
no
Removes the call-home phone number.
phone-number phone-number-string
Specifies the phone number for the contact person for this system.
Usage
Use this command to set up the phone number for Smart Call Home. The phone number must start with + and can only contain numbers. The total length is 12-16 characters. If you include spaces, then you must enclose your entry in quotes.
Example
The following command specifies the phone number as +866-111-2234:
phone-number +866-111-2234
 
profile
This command creates the call-home profile.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no ] profile profile_name
no
Removes the call-home profile.
profile profile_name
Creates or modifies the profile name for this system.
Usage
Use this command to create a new profile or modify an existing profile. This command creates the call-home-profile configuration mode.
Example
The following command creates a profile named Profile_1 :
profile Profile_1
 
rate-limit
This command enables or disables the rate-limit for the call-home features.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no | default ] rate-limit message_count
default
Sets the rate limit back to the default of 20 messages per minute.
no
Removes the call-home rate-limit.
Usage
Use this command to configure the call-home message rate limit per minute. The default is 20 messages per minute.
Example
The following command sets the call-home rate limit to 10 :
rate-limit 10
 
sender
This command specifies the call-home email settings for the from address and reply-to address.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ no | default ] sender { from email_address | to email_address }
default
Sets the sender back to the default.
from email_address
Sets the sender’s reply from address.
no
Removes the call-home sender.
to email_address
Sets the sender’s reply-to address.
Usage
Use this specify the email settings for sender. This command sets the to and from fields.
Email addresses use the form local-part@domain where the domain can be made up of a number of labels, each separated by a period and between 1 and 63 characters in length. Size limitations - local-part: 1-64 characters; domain-label: 1-63; domain: 1-135 characters - string of size 1 to 200.
Example
The following command sets the reply-to address to support@cisco.com:
semder to support@cisco.com
 
site-id
This command specifies the call-home site id string for the system..
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] site-id id_string
default
Sets the site-id back to the default.
no
Removes the call-home site-id.
Usage
Use this command to specifies the call-home site id string for the system. If you include spaces, then you must enclose your entry in quotes.
Example
The following command sets the site-id to site_1 :
site id site_1
 
street-address
This command specifies the call-home street address for the system.
Product
All
Privilege
Security Administrator, Administrator
Syntax
[ default | no ] street-address site_1
default
Sets the street-address back to the default.
no
Removes the call-home street-address.
Usage
Use this command to set up the street address for the system. You can include the street address, City, State, and ZIP Code. If you include spaces, then you must enclose your entry in quotes.
Example
The following command sets the street address to “123 Main Chicago, IL 60000”:
street-address “123 Main Chicago, IL 60000”
 
 
Cisco Systems Inc.
Tel: 408-526-4000
Fax: 408-527-0883